home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 January: Mac OS SDK / Dev.CD Jan 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / AIncludes / Folders.a < prev    next >
Encoding:
Text File  |  1997-08-12  |  11.5 KB  |  348 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        Folders.a
  3. ;
  4. ;    Contains:    Folder Manager Interfaces.
  5. ;
  6. ;    Version:    Technology:    Mac OS 8
  7. ;                Release:    Universal Interfaces 3.0.1
  8. ;
  9. ;    Copyright:    © 1995-1997 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__FOLDERS__') = 'UNDEFINED' THEN
  19. __FOLDERS__ SET 1
  20.  
  21.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  22.     include 'Types.a'
  23.     ENDIF
  24.  
  25.  
  26. kOnSystemDisk                    EQU        $8000
  27.  
  28. kCreateFolder                    EQU        1
  29. kDontCreateFolder                EQU        0
  30.  
  31. kSystemFolderType                EQU        'macs'                ; the system folder 
  32. kDesktopFolderType                EQU        'desk'                ; the desktop folder; objects in this folder show on the desk top. 
  33. kTrashFolderType                EQU        'trsh'                ; the trash folder; objects in this folder show up in the trash 
  34. kWhereToEmptyTrashFolderType    EQU        'empt'                ; the "empty trash" folder; Finder starts empty from here down 
  35. kPrintMonitorDocsFolderType        EQU        'prnt'                ; Print Monitor documents 
  36. kStartupFolderType                EQU        'strt'                ; Finder objects (applications, documents, DAs, aliases, to...) to open at startup go here 
  37. kShutdownFolderType                EQU        'shdf'                ; Finder objects (applications, documents, DAs, aliases, to...) to open at shutdown go here 
  38. kAppleMenuFolderType            EQU        'amnu'                ; Finder objects to put into the Apple menu go here 
  39. kControlPanelFolderType            EQU        'ctrl'                ; Control Panels go here (may contain INITs) 
  40. kExtensionFolderType            EQU        'extn'                ; Finder extensions go here 
  41. kFontsFolderType                EQU        'font'                ; Fonts go here 
  42. kPreferencesFolderType            EQU        'pref'                ; preferences for applications go here 
  43. kTemporaryFolderType            EQU        'temp'                ; temporary files go here (deleted periodically, but don't rely on it.) 
  44. ; 
  45. ;    Note:     The FindFolder trap was not implemented until System 7.  If you want to call FindFolder
  46. ;            while running on System 6 machines, then define USE_FINDFOLDER_GLUE and link with
  47. ;            Interface.o which contains glue to implement FindFolder on pre-System 7 machines.
  48. ;
  49.  
  50.     IF &TYPE('USE_FINDFOLDER_GLUE') <> 'UNDEFINED' THEN
  51. ;
  52. ; pascal OSErr FindFolder(short vRefNum, OSType folderType, Boolean createFolder, short *foundVRefNum, long *foundDirID)
  53. ;
  54.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  55.         IMPORT_CFM_FUNCTION FindFolder
  56.     ENDIF
  57.  
  58.     ELSE
  59. ;
  60. ; pascal OSErr FindFolder(short vRefNum, OSType folderType, Boolean createFolder, short *foundVRefNum, long *foundDirID)
  61. ;
  62.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  63.         Macro
  64.         _FindFolder
  65.             moveq               #0,D0
  66.             dc.w                $A823
  67.         EndM
  68.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  69.         IMPORT_CFM_FUNCTION FindFolder
  70.     ENDIF
  71.  
  72.     ENDIF
  73. ;
  74. ; pascal OSErr ReleaseFolder(short vRefNum, OSType folderType)
  75. ;
  76.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  77.         Macro
  78.         _ReleaseFolder
  79.             moveq               #11,D0
  80.             dc.w                $A823
  81.         EndM
  82.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  83.         IMPORT_CFM_FUNCTION ReleaseFolder
  84.     ENDIF
  85.  
  86.  
  87. ; *****************************************
  88. ;  Extensible Folder Manager declarations 
  89. ; *****************************************
  90.  
  91. ; ***************************
  92. ;  Folder Manager constants 
  93. ; ***************************
  94.  
  95. ;  new Folder Manager error codes 
  96.  
  97. badFolderDescErr                EQU        -4270
  98. duplicateFolderDescErr            EQU        -4271
  99. noMoreFolderDescErr                EQU        -4272
  100. invalidFolderTypeErr            EQU        -4273
  101. duplicateRoutingErr                EQU        -4274
  102. routingNotFoundErr                EQU        -4275
  103. badRoutingSizeErr                EQU        -4276
  104.  
  105.  
  106. kExtensionDisabledFolderType    EQU        'extD'
  107. kControlPanelDisabledFolderType    EQU        'ctrD'
  108. kSystemExtensionDisabledFolderType EQU    'macD'
  109. kStartupItemsDisabledFolderType    EQU        'strD'
  110. kShutdownItemsDisabledFolderType EQU    'shdD'
  111. kApplicationsFolderType            EQU        'apps'
  112. kDocumentsFolderType            EQU        'docs'
  113.  
  114.                                                             ; new constants 
  115. kVolumeRootFolderType            EQU        'root'                ; root folder of a volume 
  116. kChewableItemsFolderType        EQU        'flnt'                ; items deleted at boot 
  117. kApplicationSupportFolderType    EQU        'asup'                ; third-party items and folders 
  118. kTextEncodingsFolderType        EQU        'ƒtex'                ; encoding tables 
  119. kStationeryFolderType            EQU        'odst'                ; stationery 
  120. kOpenDocFolderType                EQU        'odod'                ; OpenDoc root 
  121. kOpenDocShellPlugInsFolderType    EQU        'odsp'                ; OpenDoc Shell Plug-Ins in OpenDoc folder 
  122. kEditorsFolderType                EQU        'oded'                ; OpenDoc editors in MacOS Folder 
  123. kOpenDocEditorsFolderType        EQU        'ƒodf'                ; OpenDoc subfolder of Editors folder 
  124. kOpenDocLibrariesFolderType        EQU        'odlb'                ; OpenDoc libraries folder 
  125. kGenEditorsFolderType            EQU        'ƒedi'                ; CKH general editors folder at root level of Sys folder 
  126. kHelpFolderType                    EQU        'ƒhlp'                ; CKH help folder currently at root of system folder 
  127. kInternetPlugInFolderType        EQU        'ƒnet'                ; CKH internet plug ins for browsers and stuff 
  128. kModemScriptsFolderType            EQU        'ƒmod'                ; CKH modem scripts, get 'em OUT of the Extensions folder 
  129. kPrinterDescriptionFolderType    EQU        'ppdf'                ; CKH new folder at root of System folder for printer descs. 
  130. kPrinterDriverFolderType        EQU        'ƒprd'                ; CKH new folder at root of System folder for printer drivers 
  131. kScriptingAdditionsFolderType    EQU        'ƒscr'                ; CKH at root of system folder 
  132. kSharedLibrariesFolderType        EQU        'ƒlib'                ; CKH for general shared libs. 
  133. kVoicesFolderType                EQU        'fvoc'                ; CKH macintalk can live here 
  134. kControlStripModulesFolderType    EQU        'sdev'                ; CKH for control strip modules 
  135. kAssistantsFolderType            EQU        'astƒ'                ; SJF for Assistants (MacOS Setup Assistant, etc) 
  136. kUtilitiesFolderType            EQU        'utiƒ'                ; SJF for Utilities folder 
  137. kAppleExtrasFolderType            EQU        'aexƒ'                ; SJF for Apple Extras folder 
  138. kContextualMenuItemsFolderType    EQU        'cmnu'                ; SJF for Contextual Menu items 
  139. kMacOSReadMesFolderType            EQU        'morƒ'                ; SJF for MacOS ReadMes folder 
  140. kALMModulesFolderType            EQU        'walk'                ; EAS for Location Manager Module files except type 'thng' (within kExtensionFolderType) 
  141. kALMPreferencesFolderType        EQU        'trip'                ; EAS for Location Manager Preferences (within kPreferencesFolderType; contains kALMLocationsFolderType) 
  142. kALMLocationsFolderType            EQU        'fall'                ; EAS for Location Manager Locations (within kALMPreferencesFolderType) 
  143.  
  144. ;  FolderDescFlags values 
  145.  
  146. kCreateFolderAtBoot                EQU        $00000002
  147. kFolderCreatedInvisible            EQU        $00000004
  148. kFolderCreatedNameLocked        EQU        $00000008
  149. ; typedef UInt32                         FolderDescFlags
  150.  
  151. ;  FolderClass values 
  152.  
  153. kRelativeFolder                    EQU        'relf'
  154. kSpecialFolder                    EQU        'spcf'
  155. ; typedef OSType                         FolderClass
  156.  
  157. ;  special folder locations 
  158.  
  159. kBlessedFolder                    EQU        'blsf'
  160. kRootFolder                        EQU        'rotf'
  161. ; typedef OSType                         FolderType
  162.  
  163. ; typedef OSType                         FolderLocation
  164.  
  165.  
  166. FolderDesc                RECORD 0
  167. descSize                 ds.l    1                ; offset: $0 (0)
  168. foldType                 ds.l    1                ; offset: $4 (4)
  169. flags                     ds.l    1                ; offset: $8 (8)
  170. foldClass                 ds.l    1                ; offset: $C (12)
  171. foldLocation             ds.l    1                ; offset: $10 (16)
  172. badgeSignature             ds.l    1                ; offset: $14 (20)
  173. badgeType                 ds.l    1                ; offset: $18 (24)
  174. reserved                 ds.l    1                ; offset: $1C (28)
  175. name                     ds        Str63            ; offset: $20 (32)
  176. sizeof                     EQU *                    ; size:   $60 (96)
  177.                         ENDR
  178. ; typedef struct FolderDesc *            FolderDescPtr
  179.  
  180.  
  181. ; typedef UInt32                         RoutingFlags
  182.  
  183. FolderRouting            RECORD 0
  184. descSize                 ds.l    1                ; offset: $0 (0)
  185. fileType                 ds.l    1                ; offset: $4 (4)
  186. routeFromFolder             ds.l    1                ; offset: $8 (8)
  187. routeToFolder             ds.l    1                ; offset: $C (12)
  188. flags                     ds.l    1                ; offset: $10 (16)
  189. sizeof                     EQU *                    ; size:   $14 (20)
  190.                         ENDR
  191. ; typedef struct FolderRouting *        FolderRoutingPtr
  192.  
  193. ;  routing constants 
  194. ; **************************
  195. ;  Folder Manager routines 
  196. ; **************************
  197. ;  Folder Manager administration routines 
  198. ;
  199. ; pascal OSErr AddFolderDescriptor(FolderType foldType, FolderDescFlags flags, FolderClass foldClass, FolderLocation foldLocation, OSType badgeSignature, OSType badgeType, ConstStr63Param name, Boolean replaceFlag)
  200. ;
  201.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  202.         Macro
  203.         _AddFolderDescriptor
  204.             moveq               #32,D0
  205.             dc.w                $A823
  206.         EndM
  207.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  208.         IMPORT_CFM_FUNCTION AddFolderDescriptor
  209.     ENDIF
  210.  
  211. ;
  212. ; pascal OSErr GetFolderDescriptor(FolderType foldType, Size descSize, FolderDesc *foldDesc)
  213. ;
  214.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  215.         Macro
  216.         _GetFolderDescriptor
  217.             moveq               #35,D0
  218.             dc.w                $A823
  219.         EndM
  220.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  221.         IMPORT_CFM_FUNCTION GetFolderDescriptor
  222.     ENDIF
  223.  
  224. ;
  225. ; pascal OSErr GetFolderTypes(UInt32 requestedTypeCount, UInt32 *totalTypeCount, FolderType *theTypes)
  226. ;
  227.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  228.         Macro
  229.         _GetFolderTypes
  230.             moveq               #36,D0
  231.             dc.w                $A823
  232.         EndM
  233.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  234.         IMPORT_CFM_FUNCTION GetFolderTypes
  235.     ENDIF
  236.  
  237. ;
  238. ; pascal OSErr RemoveFolderDescriptor(FolderType foldType)
  239. ;
  240.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  241.         Macro
  242.         _RemoveFolderDescriptor
  243.             moveq               #33,D0
  244.             dc.w                $A823
  245.         EndM
  246.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  247.         IMPORT_CFM_FUNCTION RemoveFolderDescriptor
  248.     ENDIF
  249.  
  250. ;  legacy routines 
  251. ;
  252. ; pascal OSErr GetFolderName(short vRefNum, OSType foldType, short *foundVRefNum, Str63 name)
  253. ;
  254.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  255.         Macro
  256.         _GetFolderName
  257.             moveq               #14,D0
  258.             dc.w                $A823
  259.         EndM
  260.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  261.         IMPORT_CFM_FUNCTION GetFolderName
  262.     ENDIF
  263.  
  264. ;  routing routines 
  265. ;
  266. ; pascal OSErr AddFolderRouting(OSType fileType, FolderType routeFromFolder, FolderType routeToFolder, RoutingFlags flags, Boolean replaceFlag)
  267. ;
  268.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  269.         Macro
  270.         _AddFolderRouting
  271.             moveq               #38,D0
  272.             dc.w                $A823
  273.         EndM
  274.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  275.         IMPORT_CFM_FUNCTION AddFolderRouting
  276.     ENDIF
  277.  
  278. ;
  279. ; pascal OSErr RemoveFolderRouting(OSType fileType, FolderType routeFromFolder)
  280. ;
  281.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  282.         Macro
  283.         _RemoveFolderRouting
  284.             moveq               #39,D0
  285.             dc.w                $A823
  286.         EndM
  287.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  288.         IMPORT_CFM_FUNCTION RemoveFolderRouting
  289.     ENDIF
  290.  
  291. ;
  292. ; pascal OSErr FindFolderRouting(OSType fileType, FolderType routeFromFolder, FolderType *routeToFolder, RoutingFlags *flags)
  293. ;
  294.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  295.         Macro
  296.         _FindFolderRouting
  297.             moveq               #34,D0
  298.             dc.w                $A823
  299.         EndM
  300.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  301.         IMPORT_CFM_FUNCTION FindFolderRouting
  302.     ENDIF
  303.  
  304. ;
  305. ; pascal OSErr GetFolderRoutings(UInt32 requestedRoutingCount, UInt32 *totalRoutingCount, Size routingSize, FolderRouting *theRoutings)
  306. ;
  307.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  308.         Macro
  309.         _GetFolderRoutings
  310.             moveq               #30,D0
  311.             dc.w                $A823
  312.         EndM
  313.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  314.         IMPORT_CFM_FUNCTION GetFolderRoutings
  315.     ENDIF
  316.  
  317. ;
  318. ; pascal OSErr InvalidateFolderDescriptorCache(short vRefNum, long dirID)
  319. ;
  320.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  321.         Macro
  322.         _InvalidateFolderDescriptorCache
  323.             moveq               #37,D0
  324.             dc.w                $A823
  325.         EndM
  326.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  327.         IMPORT_CFM_FUNCTION InvalidateFolderDescriptorCache
  328.     ENDIF
  329.  
  330. ;
  331. ; pascal OSErr IdentifyFolder(short vRefNum, long dirID, FolderType *foldType)
  332. ;
  333.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  334.         Macro
  335.         _IdentifyFolder
  336.             moveq               #31,D0
  337.             dc.w                $A823
  338.         EndM
  339.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  340.         IMPORT_CFM_FUNCTION IdentifyFolder
  341.     ENDIF
  342.  
  343.  
  344.  
  345.  
  346.     ENDIF ; __FOLDERS__ 
  347.  
  348.